.TH WOKD 8 "February 05, 2015" "Version @PACKAGE_VERSION@" "Wok Manual"
.SH NAME
wokd - Launch Wok web server
.SH SYNOPSIS
.B wokd
[\fB-h\fP|\fB--help\fP] [\fB--proxy_port\fP \fIPROXY_PORT\fP]
[\fB--cherrypy_port\fP \fICHERRYPY_PORT\fP] [\fB--websockets_port\fP \fIWEBSOCKETS_PORT\fP]
[\fB--session_timeout\fP \fISESSION_TIMEOUT\fP] [\fB--log_level\fP \fILOG_LEVEL\fP]
[\fB--log_dir\fP \fILOG_DIR\fP] [\fB--environment\fP \fIENV\fP]
[\fB--server_root\fP \fISERVER_ROOT\fP] [\fB--federation\fP \fIfederation\fP] [\fB--test\fP]
.SH DESCRIPTION
\fBWok\fP is a cherrypy-based web framework with HTML5 support originated from Kimchi.
It can be extended by plugins which expose functionality through REST APIs.

\fBwokd\fP launches the web server and load all the installed plugins as part of an intuitive
web interface that can be accessible over HTTP or HTTPS according to the configuration specified in
/etc/wok/wok.conf and /etc/nginx/conf.d/wok.conf

By default, Wok uses nginx as a reverse proxy and it launches a cherrypy process on localhost for
security matters. The nginx can be replaced by other proxy without problems. Just make sure to have
the configuration aligned in /etc/wok/wok.conf
.SH OPTIONS
Most of the options provide mechanism to change the web server configuration and must be aligned with
the proxy configuration as well. So check /etc/nginx/conf.d/wok.conf

The following options are supported:
.TP
\fB\-h\fP , \fB\-\-help\fP
Show this help message and exit.
.TP
\fB\-\-proxy_port\fP \fIPROXY_PORT\fP
Wok runs behind a reverse proxy so use this option to specify on which HTTPS
port the proxy is running (default \fI8001\fP).
.TP
\fB\-\-cherrypy_port\fP \fICHERRYPY_PORT\fP
Corresponds to the Cherrypy server port (default \fI8010\fP).
Cherrypy will run on localhost so no firewall configuration is needed for that.
.TP
\fB\-\-websockets_port\fP \fIWEBSOCKETS_PORT\fP
Corresponds to the Websockets port (default \fI64667\fP).
.TP
\fB\-\-session_timeout\fP \fISESSION_TIMEOUT\fP
Number of minutes that a session can remain idle before the server terminates it automatically (default \fI10\fP).
.TP
\fB\-\-log_level\fP [\fIdebug\fP | \fIinfo\fP | \fIwarning\fP | \fIerror\fP | \fIcritical\fP]
Specify the application log level (default \fIdebug\fP).
.TP
\fB\-\-log_dir\fP [\fILOG_DIR\fP]
Specify the log files location (default \fI/var/log/wok/\fP).
.TP
\fB\-\-environment\fP [\fIdev\fP | \fIproduction\fP]
Specify the running environment of Wok server.
Check cherrypy documentation for more details (default \fIproduction\fP).
.TP
\fB\-\-server_root\fP [\fISERVER_ROOT\fP]
Relative path to Wok server. No value is specified by default, ie, Wok will run on '/'.
.TP
\fB\-\-federation\fP [\fIon\fP | \fIoff\fP]
Register and discover Wok peers in the same network using OpenSLP. Check
below the \fBREAD-federation\fP for more details (default \fIoff\fP).
.TP
\fB\-\-test\fP
Run Wok on a mock version that does not affect the system. For testing proposals.
It depends on how plugins implements the mock environment as well.
.SH SIGNALS
Wok relies on Cherrypy to handle system signals as below:

\fBSIGTERM\fP: Stop all services and prepare to exit the process.

\fBSIGHUP\fP: Restart if daemonized, else exit.

\fBSIGUSR1\fP: Advise all services to reload.
.SH FILES
.I /etc/wok/wok.conf
.RS
The Wok server configuration file.
.RE
.I /etc/nginx/conf.d/wok.conf
.RS
The nginx configuration to server Wok server configuration. It must be aligned with /etc/wok/wok.conf content.
.RE
.I /etc/logrotate.d/wokd
.RS
The logrotate configuration file for Wok logs.
.RE
.I /usr/lib/firewalld/services/wokd.xml
.RS
The firewalld configuration file for Wok server.
.RE
.SH LICENCE
.br
Wok is distributed pursuant to the terms of two different licenses.
.br
The user interface (located in ui/ in this distribution) is governed by
the Apache License version 2.0. More details about all the imported code and
its correspondent license information can be found in COPYING file.

The rest of this distribution is governed by the GNU Lesser General Public
License version 2.1+.

See COPYING, COPYING.LGPL and COPYING.ASL2.
.SH BUGS
.br
Please report all bugs you find.
.br
This should be done on bug tracker <https://github.com/kimchi-project/wok/issues/new>
.br
You can also report bugs to your software distributor/vendor.
.SH AUTHOR
Please refer to the AUTHORS file distributed with Wok.
.SH SEE ALSO
<https://github.com/kimchi-project/wok>, <http://kimchi-project.github.io/wok>
